<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NMVPNConnection</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libnm-glib Reference Manual">
<link rel="up" href="ch02.html" title="libnm-glib API Reference">
<link rel="prev" href="NMSecretAgent.html" title="NMSecretAgent">
<link rel="next" href="libnm-glib-NMVPNPlugin.html" title="NMVPNPlugin">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="NMSecretAgent.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libnm-glib Reference Manual</th>
<td><a accesskey="n" href="libnm-glib-NMVPNPlugin.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#NMVPNConnection.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#NMVPNConnection.description" class="shortcut">Description</a>
                   | 
                  <a href="#NMVPNConnection.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#NMVPNConnection.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#NMVPNConnection.properties" class="shortcut">Properties</a>
                   | 
                  <a href="#NMVPNConnection.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="NMVPNConnection"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NMVPNConnection.top_of_page"></a>NMVPNConnection</span></h2>
<p>NMVPNConnection</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="NMVPNConnection.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">                    <a class="link" href="NMVPNConnection.html#NMVPNConnection-struct" title="NMVPNConnection">NMVPNConnection</a>;
                    <a class="link" href="NMVPNConnection.html#NMVPNConnectionClass" title="NMVPNConnectionClass">NMVPNConnectionClass</a>;
#define             <a class="link" href="NMVPNConnection.html#NM-VPN-CONNECTION-BANNER:CAPS" title="NM_VPN_CONNECTION_BANNER">NM_VPN_CONNECTION_BANNER</a>
#define             <a class="link" href="NMVPNConnection.html#NM-VPN-CONNECTION-VPN-STATE:CAPS" title="NM_VPN_CONNECTION_VPN_STATE">NM_VPN_CONNECTION_VPN_STATE</a>
const <span class="returnvalue">char</span> *        <a class="link" href="NMVPNConnection.html#nm-vpn-connection-get-banner" title="nm_vpn_connection_get_banner ()">nm_vpn_connection_get_banner</a>        (<em class="parameter"><code><a class="link" href="NMVPNConnection.html" title="NMVPNConnection"><span class="type">NMVPNConnection</span></a> *vpn</code></em>);
<span class="returnvalue">NMVPNConnectionState</span> <a class="link" href="NMVPNConnection.html#nm-vpn-connection-get-vpn-state" title="nm_vpn_connection_get_vpn_state ()">nm_vpn_connection_get_vpn_state</a>    (<em class="parameter"><code><a class="link" href="NMVPNConnection.html" title="NMVPNConnection"><span class="type">NMVPNConnection</span></a> *vpn</code></em>);
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> *           <a class="link" href="NMVPNConnection.html#nm-vpn-connection-new" title="nm_vpn_connection_new ()">nm_vpn_connection_new</a>               (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *connection</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="NMVPNConnection.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a class="link" href="NMObject.html" title="NMObject">NMObject</a>
         +----<a class="link" href="NMActiveConnection.html" title="NMActiveConnection">NMActiveConnection</a>
               +----NMVPNConnection
</pre>
</div>
<div class="refsect1">
<a name="NMVPNConnection.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
NMVPNConnection implements
 <a href="http://library.gnome.org/devel/gio/unstable/GInitable.html">GInitable</a> and  <a href="http://library.gnome.org/devel/gio/unstable/GAsyncInitable.html">GAsyncInitable</a>.</p>
</div>
<div class="refsect1">
<a name="NMVPNConnection.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="NMVPNConnection.html#NMVPNConnection--banner" title='The "banner" property'>banner</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
  "<a class="link" href="NMVPNConnection.html#NMVPNConnection--vpn-state" title='The "vpn-state" property'>vpn-state</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read
</pre>
</div>
<div class="refsect1">
<a name="NMVPNConnection.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="NMVPNConnection.html#NMVPNConnection-vpn-state-changed" title='The "vpn-state-changed" signal'>vpn-state-changed</a>"                              : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
</pre>
</div>
<div class="refsect1">
<a name="NMVPNConnection.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="NMVPNConnection.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="NMVPNConnection-struct"></a><h3>NMVPNConnection</h3>
<pre class="programlisting">typedef struct _NMVPNConnection NMVPNConnection;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="NMVPNConnectionClass"></a><h3>NMVPNConnectionClass</h3>
<pre class="programlisting">typedef struct {
	NMActiveConnectionClass parent;

	/* Signals */
	void (*vpn_state_changed) (NMVPNConnection *connection,
	                           NMVPNConnectionState state,
	                           NMVPNConnectionStateReason reason);

	/* Padding for future expansion */
	void (*_reserved1) (void);
	void (*_reserved2) (void);
	void (*_reserved3) (void);
	void (*_reserved4) (void);
	void (*_reserved5) (void);
	void (*_reserved6) (void);
} NMVPNConnectionClass;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-VPN-CONNECTION-BANNER:CAPS"></a><h3>NM_VPN_CONNECTION_BANNER</h3>
<pre class="programlisting">#define NM_VPN_CONNECTION_BANNER "banner"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-VPN-CONNECTION-VPN-STATE:CAPS"></a><h3>NM_VPN_CONNECTION_VPN_STATE</h3>
<pre class="programlisting">#define NM_VPN_CONNECTION_VPN_STATE "vpn-state"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="nm-vpn-connection-get-banner"></a><h3>nm_vpn_connection_get_banner ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *        nm_vpn_connection_get_banner        (<em class="parameter"><code><a class="link" href="NMVPNConnection.html" title="NMVPNConnection"><span class="type">NMVPNConnection</span></a> *vpn</code></em>);</pre>
<p>
Gets the VPN login banner of the active <a class="link" href="NMVPNConnection.html" title="NMVPNConnection"><span class="type">NMVPNConnection</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>vpn</code></em> :</span></p></td>
<td>a <a class="link" href="NMVPNConnection.html" title="NMVPNConnection"><span class="type">NMVPNConnection</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the VPN login banner of the VPN connection. This is the internal
string used by the connection, and must not be modified.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="nm-vpn-connection-get-vpn-state"></a><h3>nm_vpn_connection_get_vpn_state ()</h3>
<pre class="programlisting"><span class="returnvalue">NMVPNConnectionState</span> nm_vpn_connection_get_vpn_state    (<em class="parameter"><code><a class="link" href="NMVPNConnection.html" title="NMVPNConnection"><span class="type">NMVPNConnection</span></a> *vpn</code></em>);</pre>
<p>
Gets the current <a class="link" href="NMVPNConnection.html" title="NMVPNConnection"><span class="type">NMVPNConnection</span></a> state.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>vpn</code></em> :</span></p></td>
<td>a <a class="link" href="NMVPNConnection.html" title="NMVPNConnection"><span class="type">NMVPNConnection</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the VPN state of the active VPN connection.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="nm-vpn-connection-new"></a><h3>nm_vpn_connection_new ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> *           nm_vpn_connection_new               (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *connection</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre>
<p>
Creates a new <a class="link" href="NMVPNConnection.html" title="NMVPNConnection"><span class="type">NMVPNConnection</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>the <a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>the DBus object path of the new connection</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new connection object. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="NMVPNConnection.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="NMVPNConnection--banner"></a><h3>The <code class="literal">"banner"</code> property</h3>
<pre class="programlisting">  "banner"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
<p>
The VPN login banner of the active VPN connection.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="NMVPNConnection--vpn-state"></a><h3>The <code class="literal">"vpn-state"</code> property</h3>
<pre class="programlisting">  "vpn-state"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read</pre>
<p>
The VPN state of the active VPN connection.
</p>
<p>Allowed values: &lt;= 7</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1">
<a name="NMVPNConnection.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="NMVPNConnection-vpn-state-changed"></a><h3>The <code class="literal">"vpn-state-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="NMVPNConnection.html" title="NMVPNConnection"><span class="type">NMVPNConnection</span></a> *nmvpnconnection,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>            arg1,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>            arg2,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)            : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>nmvpnconnection</code></em> :</span></p></td>
<td>the object which received the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>